home *** CD-ROM | disk | FTP | other *** search
/ Level Mania 2 / Level Mania 2.iso / CD2 / EDITOR / PRG1.ZIP / DN3D-DC.TXT < prev    next >
Encoding:
Text File  |  1996-03-14  |  6.3 KB  |  181 lines
  1. Duke Nukem 3D - Decompiler/Compiler version 1.1
  2. By Daniel Mecklenburg Jr  codewar@ns.cencom.net
  3. http://www.geocities.com/SiliconValley/4794
  4.  
  5. Disclaimer
  6. ==========
  7.  
  8. THIS PROGRAM IS OFFERED AS FREEWARE AND ON AN AS-IS BASIS.  THE AUTHOR
  9. WILL NOT BE HELD RESPONSIBLE FOR ANY PROBLEMS OCCURED FROM USE OR MISUSE
  10. OF THIS PROGRAM.  I CAN NOT PROMISE THAT THIS PROGRAM WILL RUN ON ANY
  11. MACHINE OR EVEN RUN PROPERLY. I CAN ONLY SAY THAT IT RUNS ON MY SYSTEM
  12. (PENTIUM 120 MHZ W/16 MB RAM UNDER WIN95). THE EXECUTABLE INCLUDED WAS
  13. COMPILED USING BORLAND C++ 4.5 WITH BORLAND POWERPACK. I HAVE NOT INCLUDED
  14. THE PROJECT FILES, SIMPLY THE C SOURCE FOR YOUR OWN USE.
  15.  
  16.  
  17. Intro
  18. =====
  19.  
  20. This program will allow you pull the resources out
  21. of the DUKE3D.GRP file and store them as individual
  22. files so they can be edited and then recompiled.
  23.  
  24. The DUKE3D.GRP file contains the following file types:
  25.  
  26.     Extention   Description
  27.    .CON        The 'scripting' files used by the game
  28.    .TMB        Not certain
  29.    .BIN        Not certain
  30.    .DAT        Various date files. PALETTE.DAT contains
  31.                the color palette information.
  32.    .VOC        Sound Blaster sound file
  33.    .MID        MIDI music file
  34.     .ART        Graphic data (see below)
  35.    .MAP        Level maps.
  36.  
  37. The only types that at this time concern me are the .VOC,
  38. .MID, and .ART files to alter the appearance of DN3D.
  39.  
  40.  
  41. Usage
  42. =====
  43.  
  44. preparation
  45. -----------
  46.    It is wise to make a backup of the original DUKE3D.GRP
  47. file before proceeding much further. DN3D-DC will create a
  48. backup of GRP and ART files before they get recompiled,
  49. however this backup only has a one cycle lifespan (meaning
  50. if you recompile twice, the first time the backup is of
  51. the original, the second it is of the last recompile).
  52.  
  53.     Create a directory that house the decompiled resources.
  54. I usually do this off the DUKE3D directory but it could
  55. be anywhere. In the following examples the game is in
  56. G:\DUKE3D and I'll keep the resources in G:\DUKE3D\RES
  57.  
  58. decompile grp file
  59. ------------------
  60.     To decompile the GRP file, type:
  61.  
  62.         DN3D-DC DG G:\DUKE3D\DUKE3D.GRP G:\DUKE3D\RES
  63.                   |            |                |
  64.                   |            |         path to where the
  65.                   |            |         resources will be
  66.                   |            |              stored.
  67.                   |     path/name to the
  68.                   |     DUKE3D.GRP file.
  69.                   |
  70.                   command for "Decompile Grp"
  71.  
  72.     All of the files in the GRP file will now be in the
  73. G:\DUKE3D\RES directory along with a file called DUKE3D.LST.
  74. This file is a text file containing the packing list for
  75. the group file. This file is needed if you intend to
  76. recompile the GRP file again. The string names should be
  77. kept as they are in this list as the game indexes this file
  78. by name I'm almost certain.
  79.  
  80. decompile art file
  81. ------------------
  82.     To decomile the ART files (contains the graphics), type:
  83.  
  84.         DN3D-DC DA G:\DUKE3D\RES\TILES000.ART G:\DUKE3D\RES
  85.                   |               |                    |
  86.                   |               |             path to where the
  87.                   |               |             BMP files are to be
  88.                   |               |             stored.
  89.                   |               |
  90.                   |  path/name to the ART file.
  91.                   |  PALETTE.DAT must be in this same directory.
  92.                   |
  93.                   command for "Decompile Art"
  94.  
  95.     All the graphics for TILES000.ART will be stored in the
  96. G:\DUKE3D\RES directory along with a file called TILES000.LST.
  97. This file is a text file containt the packing list for
  98. the group file. This file is needed if you intend to recompile
  99. the ART file again.
  100.  
  101.     The naming convention for BMP is a three digit value followed
  102. by a hyphen and then the last three digits of the TILES???.ART
  103. file. The first file in TILES000.ART is 000-000.BMP. The second
  104. one is 001-000.BMP, etc.
  105.  
  106.     String information and BMP naming is not important. What is,
  107. is that you use the palette created in the individual BMPs for
  108. the new BMPs, that the size of the new BMPs are the same as the
  109. old BMPs, and that you do not save the BMPs are RLE but rather
  110. RGB compressed. (RGB compressed means uncompressed).
  111.  
  112.     Do not delete the entries in the TILES???.LST files that have
  113. the filename ****************. These contain information pertaining
  114. to animation sequences and stuff that I have not yet decyphered.
  115. All I know is that it is important that they be there.
  116.  
  117. compile art file
  118. ----------------
  119.     To compile the ART file from the LST file and the BMP's, type:
  120.  
  121.         DN3D-DC CA G:\DUKE3D\RES\TILES000.ART G:\DUKE3D\RES
  122.                   |              |                   |
  123.                   |              |              where the BMPs and
  124.                   |              |              the LST file are.
  125.                   |              |
  126.                   |  Path/name to the ART file
  127.                   |       being compiled.
  128.                   |
  129.                   command for "Compile Art"
  130.  
  131.     Using the TILES000.LST, this will take the BMPs in the
  132. G:\DUKE3D\RES and create TILES000.ART file. Palette information
  133. from any new BMP is discarded so be sure that any new artwork
  134. uses the same palette as the original.
  135.  
  136. compile grp file
  137. ----------------
  138.     To compile the GRP file from the LST file and resource files,
  139. type:
  140.  
  141.         DN3D-DC CG G:\DUKE3D\DUKE3D.GRP G:\DUKE3D\RES
  142.                   |            |                 |
  143.                   |            |          directory where
  144.                   |            |          the resource files and
  145.                   |            |          DUKE3D.LST file is.
  146.                   |            |
  147.                   |  path/name of the GRP
  148.                   |  file that is being created
  149.                   |
  150.                   command for "Compile Grp"
  151.  
  152.     Using the DUKE3D.LST in the G:\DUKE3D\RES directory, the
  153. DUKE3D.GRP file will be generated with the resources in
  154. G:\DUKE3D\RES
  155.  
  156. hints
  157. -----
  158.     Some of the VOC files load funny in some software. If it tries
  159. to load as RAW data, try using 8000 hz sampling.
  160.  
  161.     Load one BMP file and save its palette in your favorite bitmap
  162. editor for later use. Most editors will allow you to remap an
  163. image to another palette.
  164.  
  165.    Automate your decompile/compile process with batch files. This
  166. speeds things up a bit.
  167.  
  168.    If you are a C programmer feel free to use the source code to
  169. either beef this program up or add to it if you know any new
  170. information that I don't. :-) Only thing I ask is that I get
  171. some credit for it all.
  172.  
  173.  
  174. History
  175. =======
  176.  
  177. Version 1.0  -  Initial release
  178.  
  179. Version 1.1  -  Compiled for 16 protected mode. Fixed typo in docs
  180.  
  181.